doc: sort documentation alphabetically #3662
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reorders, with no contextual changes, the assert documentation alphabetically.
Reorders, with minimal contextual duplication, the buffer documentation alphabetically.
Reorders, with no contextual changes, the child_process documentation alphabetically.
Reorders, with no contextual changes, the cluster documentation alphabetically.
Reorders, with no contextual changes, the console documentation alphabetically.
Reorders, with no contextual changes, the dns documentation alphabetically.
8 tasks
|
@tflanagan could you please push new commits, or amend + force-push instead of opening new PRs? thanks! :D |
|
cc @nodejs/documentation -- I am greatly in favor of this. |
|
@Fishrock123, I had to open a new PR because the old one was against v4.x, I am sorry for polluting. |
tflanagan
force-pushed
the
doc-sort-alpha
branch
from
1aa2abf
to
f92f016
Compare
|
I can't seem to find any one convention with the ordering of classes, methods, properties, and random text blurbs |
|
@tflanagan ... thank you for this work. It's great stuff. And thank you for bearing with me on the targeting of the PR (I know it's a pain). I should have time to take a look at the changes in detail later on today or tomorrow but so far things are looking good. |
tflanagan
force-pushed
the
doc-sort-alpha
branch
from
be35e83
to
4a79551
Compare
|
The zlib documentation is completely different from the rest of the docs. I'm about to commit this file, but just want to give a heads up. Things I changed:
The convenience methods subtree is an odd ball compared to the rest of the docs. So is Class Options and Constants. This file should really be conformed to the rest of the docs. --- I'll have this finished by the end of the day, will do a rebase on master and pull in the new changes since this PR. |
Reorders, with no contextual changes, the crypto documentation alphabetically.
Reorders, with no contextual changes, the dgram documentation alphabetically.
Reorders, with no contextual changes, the errors documentation alphabetically.
Reorders, with minimal contextual duplication, the events documentation alphabetically.
Reorders, with no contextual changes, the fs documentation alphabetically.
Reorders, with no contextual changes, the globals documentation alphabetically.
Reorders, with no contextual changes, the os documentation alphabetically.
Reorders, with no contextual changes, the path documentation alphabetically.
Reorders, with no contextual changes, the punycode documentation alphabetically.
Reorders, with no contextual changes, the querystring documentation alphabetically.
Reorders, with no contextual changes, the vm documentation alphabetically.
Reorders, with no contextual changes, the url documentation alphabetically.
Reorders, with no contextual changes, the tty documentation alphabetically.
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the querystring documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the vm documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the url documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the tty documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the timers documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the string_decode documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the repl documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the readline documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the modules documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the http documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the https documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the util documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with some contextual changes, the zlib documentation alphabetically. - Put Convenience Methods children under the Convenience Methods header - Renamed Options to Class Options and put above the Class definitions PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the process documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with minimal contextual duplication, the net documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the stream documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
Dec 23, 2015
Reorders, with no contextual changes, the tls documentation alphabetically. PR-URL: #3662 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
bbondy
pushed a commit
to brave/node
that referenced
this pull request
Mar 13, 2016
Notable changes: * buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767. - This makes the behavior match what the docs suggest. * child_process: `child.send()` now properly returns a boolean like the docs suggest (Rich Trott) nodejs/node#3577. * doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662. * http_parser: update http-parser to 2.6.0 from 2.5.0 (James M Snell) nodejs/node#3569. - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`, `REBIND`, `UNBIND`. - Also added ACL and IPv6 Zone ID support. * npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner) nodejs/node#3685. - See the release notes for https://github.com/npm/npm/releases/tag/v3.3.7, https://github.com/npm/npm/releases/tag/v3.3.8, https://github.com/npm/npm/releases/tag/v3.3.9, https://github.com/npm/npm/releases/tag/v3.3.10, https://github.com/npm/npm/releases/tag/v3.3.11, and https://github.com/npm/npm/releases/tag/v3.3.12 for more details. * repl: The REPL no longer crashes if the persistent history file cannot be opened (Evan Lucas) nodejs/node#3630. * tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755. * v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779. PR-URL: nodejs/node#3736
bbondy
pushed a commit
to brave/node
that referenced
this pull request
Mar 14, 2016
Notable changes: * buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767. - This makes the behavior match what the docs suggest. * child_process: `child.send()` now properly returns a boolean like the docs suggest (Rich Trott) nodejs/node#3577. * doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662. * http_parser: update http-parser to 2.6.0 from 2.5.0 (James M Snell) nodejs/node#3569. - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`, `REBIND`, `UNBIND`. - Also added ACL and IPv6 Zone ID support. * npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner) nodejs/node#3685. - See the release notes for https://github.com/npm/npm/releases/tag/v3.3.7, https://github.com/npm/npm/releases/tag/v3.3.8, https://github.com/npm/npm/releases/tag/v3.3.9, https://github.com/npm/npm/releases/tag/v3.3.10, https://github.com/npm/npm/releases/tag/v3.3.11, and https://github.com/npm/npm/releases/tag/v3.3.12 for more details. * repl: The REPL no longer crashes if the persistent history file cannot be opened (Evan Lucas) nodejs/node#3630. * tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755. * v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779. PR-URL: nodejs/node#3736
bbondy
pushed a commit
to brave/node
that referenced
this pull request
Mar 14, 2016
Notable changes: * buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767. - This makes the behavior match what the docs suggest. * child_process: `child.send()` now properly returns a boolean like the docs suggest (Rich Trott) nodejs/node#3577. * doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662. * http_parser: update http-parser to 2.6.0 from 2.5.0 (James M Snell) nodejs/node#3569. - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`, `REBIND`, `UNBIND`. - Also added ACL and IPv6 Zone ID support. * npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner) nodejs/node#3685. - See the release notes for https://github.com/npm/npm/releases/tag/v3.3.7, https://github.com/npm/npm/releases/tag/v3.3.8, https://github.com/npm/npm/releases/tag/v3.3.9, https://github.com/npm/npm/releases/tag/v3.3.10, https://github.com/npm/npm/releases/tag/v3.3.11, and https://github.com/npm/npm/releases/tag/v3.3.12 for more details. * repl: The REPL no longer crashes if the persistent history file cannot be opened (Evan Lucas) nodejs/node#3630. * tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755. * v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779. PR-URL: nodejs/node#3736
bbondy
pushed a commit
to brave/node
that referenced
this pull request
Mar 15, 2016
Notable changes: * buffer: The `noAssert` option for many buffer functions will now silently drop invalid write values rather than crashing (P.S.V.R) nodejs/node#3767. - This makes the behavior match what the docs suggest. * child_process: `child.send()` now properly returns a boolean like the docs suggest (Rich Trott) nodejs/node#3577. * doc: All of the API docs have been re-ordered so as to read in alphabetical order (Tristian Flanagan) nodejs/node#3662. * http_parser: update http-parser to 2.6.0 from 2.5.0 (James M Snell) nodejs/node#3569. - Now supports the following HTTP methods: `LINK`, `UNLINK`, `BIND`, `REBIND`, `UNBIND`. - Also added ACL and IPv6 Zone ID support. * npm: upgrade npm to 3.3.12 from v3.3.6 (Rebecca Turner) nodejs/node#3685. - See the release notes for https://github.com/npm/npm/releases/tag/v3.3.7, https://github.com/npm/npm/releases/tag/v3.3.8, https://github.com/npm/npm/releases/tag/v3.3.9, https://github.com/npm/npm/releases/tag/v3.3.10, https://github.com/npm/npm/releases/tag/v3.3.11, and https://github.com/npm/npm/releases/tag/v3.3.12 for more details. * repl: The REPL no longer crashes if the persistent history file cannot be opened (Evan Lucas) nodejs/node#3630. * tls: The default `sessionIdContext` now uses SHA1 in FIPS mode rather than MD5 (Stefan Budeanu) nodejs/node#3755. * v8: Added some more useful post-mortem data (Fedor Indutny) nodejs/node#3779. PR-URL: nodejs/node#3736
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a follow up to #3651, #3652, and to #393, I've started from the top and am working my way down.
I am posting this now because it is a big diff and will need eyes.
Docs that have been completed:
debuggerdomain